<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>ByExampleFinder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/api/finders/ByExampleFinder.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*****************************************************************************</em></em>
<a name="2" href="#2">2</a>   <em> * ExampleFinder.java - created by aaronz@vt.edu</em>
<a name="3" href="#3">3</a>   <em> * </em>
<a name="4" href="#4">4</a>   <em> * Copyright (c) 2006 Aaron Zeckoski</em>
<a name="5" href="#5">5</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="6" href="#6">6</a>   <em> * </em>
<a name="7" href="#7">7</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="8" href="#8">8</a>   <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="9" href="#9">9</a>   <em> * </em>
<a name="10" href="#10">10</a>  <em> * Contributors:</em>
<a name="11" href="#11">11</a>  <em> * Aaron Zeckoski (aaronz@vt.edu) - primary</em>
<a name="12" href="#12">12</a>  <em> * </em>
<a name="13" href="#13">13</a>  <em> *****************************************************************************/</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.api.finders;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.util.List;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <em>/**<em>*</em></em>
<a name="20" href="#20">20</a>  <em> * This finder includes methods to find persistent objects </em>
<a name="21" href="#21">21</a>  <em> * based on and example of the object</em>
<a name="22" href="#22">22</a>  <em> * </em>
<a name="23" href="#23">23</a>  <em> * @author Aaron Zeckoski (aaronz@vt.edu)</em>
<a name="24" href="#24">24</a>  <em> * @deprecated The example finder will be removed in the next version</em>
<a name="25" href="#25">25</a>  <em> */</em>
<a name="26" href="#26">26</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/sakaiproject/genericdao/api/finders/ByExampleFinder.html">ByExampleFinder</a> {
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  	<em>/**<em>*</em></em>
<a name="29" href="#29">29</a>  <em>	 * Find all objects of the type associated with this DAO based on</em>
<a name="30" href="#30">30</a>  <em>	 * the provided example object and return them in a List. Any non-null </em>
<a name="31" href="#31">31</a>  <em>	 * properties will be matched exactly and any null values will</em>
<a name="32" href="#32">32</a>  <em>	 * be ignored.</em>
<a name="33" href="#33">33</a>  <em>	 * &lt;p></em>
<a name="34" href="#34">34</a>  <em>	 * &lt;b>Note:&lt;/b> even though this method accepts any object, you should only</em>
<a name="35" href="#35">35</a>  <em>	 * give it the associated persistent object type.</em>
<a name="36" href="#36">36</a>  <em>	 * &lt;p></em>
<a name="37" href="#37">37</a>  <em>	 * &lt;b>Note:&lt;/b> If you use primitive types in your persistent objects then</em>
<a name="38" href="#38">38</a>  <em>	 * those values cannot be null and must be set to something or the example</em>
<a name="39" href="#39">39</a>  <em>	 * matches will not work the way you expect.</em>
<a name="40" href="#40">40</a>  <em>	 * &lt;p></em>
<a name="41" href="#41">41</a>  <em>	 * </em>
<a name="42" href="#42">42</a>  <em>	 * @param exampleObject - an example object which should have null for any</em>
<a name="43" href="#43">43</a>  <em>	 * properties which should not be matched and</em>
<a name="44" href="#44">44</a>  <em>	 * @return a List of 0 or more persistent objects</em>
<a name="45" href="#45">45</a>  <em>	 * @deprecated will be removed in the next version</em>
<a name="46" href="#46">46</a>  <em>	 */</em>
<a name="47" href="#47">47</a>  	@SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="48" href="#48">48</a>     <strong>public</strong> List findByExample(Object exampleObject);
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  	<em>/**<em>*</em></em>
<a name="51" href="#51">51</a>  <em>	 * Find all objects of the type associated with this DAO based on</em>
<a name="52" href="#52">52</a>  <em>	 * the provided example object and return them in a List. Any non-null </em>
<a name="53" href="#53">53</a>  <em>	 * properties will be matched exactly and any null values will</em>
<a name="54" href="#54">54</a>  <em>	 * be ignored.</em>
<a name="55" href="#55">55</a>  <em>	 * &lt;p></em>
<a name="56" href="#56">56</a>  <em>	 * Order is not guaranteed.</em>
<a name="57" href="#57">57</a>  <em>	 * </em>
<a name="58" href="#58">58</a>  <em>	 * @param exampleObject - an example object which should have null for any</em>
<a name="59" href="#59">59</a>  <em>	 * properties which should not be matched and</em>
<a name="60" href="#60">60</a>  <em>	 * @param firstResult - the index of the first result object to be retrieved (numbered from 0)</em>
<a name="61" href="#61">61</a>  <em>	 * @param maxResults - the maximum number of result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="62" href="#62">62</a>  <em>	 * @return a List of 0 or more persistent objects</em>
<a name="63" href="#63">63</a>  <em>	 * @see #findByExample(Object)</em>
<a name="64" href="#64">64</a>  <em>	 * @deprecated will be removed in the next version</em>
<a name="65" href="#65">65</a>  <em>	 */</em>
<a name="66" href="#66">66</a>  	@SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="67" href="#67">67</a>     <strong>public</strong> List findByExample(Object exampleObject, <strong>int</strong> firstResult, <strong>int</strong> maxResults);
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

